home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / pyshared / jockey / ui.py < prev    next >
Text File  |  2009-10-25  |  36KB  |  920 lines
  1. # (c) 2007 Canonical Ltd.
  2. #
  3. # This program is free software; you can redistribute it and/or modify
  4. # it under the terms of the GNU General Public License as published by
  5. # the Free Software Foundation; either version 2 of the License, or
  6. # (at your option) any later version.
  7. #
  8. # This program is distributed in the hope that it will be useful,
  9. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11. # GNU General Public License for more details.
  12. #
  13. # You should have received a copy of the GNU General Public License along
  14. # with this program; if not, write to the Free Software Foundation, Inc.,
  15. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16.  
  17. '''Abstract user interface, which provides all logic and strings.
  18.  
  19. Concrete implementations need to implement a set of abstract presentation
  20. functions with an appropriate toolkit.
  21. '''
  22.  
  23. import gettext, optparse, urllib2, tempfile, sys, time, os, threading
  24.  
  25. import gobject
  26. import dbus
  27. import dbus.service
  28. import dbus.mainloop.glib
  29.  
  30. from oslib import OSLib
  31. from backend import UnknownHandlerException, PermissionDeniedByPolicy, \
  32.     BackendCrashError, convert_dbus_exceptions, \
  33.     dbus_sync_call_signal_wrapper, Backend, DBUS_BUS_NAME
  34.  
  35. def bool(str):
  36.     '''Convert backend encoding of a boolean to a real boolean.'''
  37.  
  38.     if str == 'True':
  39.         return True
  40.     assert str == 'False'
  41.     return False
  42.  
  43. # Avoid having to do .encode('UTF-8') everywhere. This is a pain; I wish
  44. # Python supported something like "sys.stdout.encoding = 'UTF-8'".
  45. def __fix_stdouterr():
  46.     import codecs
  47.     import locale
  48.     def null_decode(input, errors='strict'):
  49.         return input, len(input)
  50.     sys.stdout = codecs.EncodedFile(sys.stdout, locale.getpreferredencoding())
  51.     sys.stdout.decode = null_decode
  52.     sys.stderr = codecs.EncodedFile(sys.stderr, locale.getpreferredencoding())
  53.     sys.stderr.decode = null_decode
  54.  
  55. __fix_stdouterr()
  56.  
  57. class AbstractUI(dbus.service.Object):
  58.     '''Abstract user interface.
  59.  
  60.     This encapsulates the entire program logic and all strings, but does not
  61.     implement any concrete user interface.
  62.     '''
  63.     def __init__(self):
  64.         '''Initialize system.
  65.         
  66.         This parses command line arguments, detects available hardware,
  67.         and already installed drivers and handlers.
  68.         '''
  69.         gettext.install('jockey', unicode=True)
  70.  
  71.         (self.argv_options, self.argv_args) = self.parse_argv()
  72.  
  73.         if self.argv_options.check:
  74.             time.sleep(self.argv_options.check)
  75.  
  76.         self.init_strings()
  77.  
  78.         self._dbus_iface = None
  79.         self.dbus_server_main_loop = None
  80.         self.have_ui = False
  81.         self.current_search = (None, None) # query, result
  82.  
  83.     def backend(self):
  84.         '''Return D-BUS backend client interface.
  85.  
  86.         This gets initialized lazily.
  87.         '''
  88.         if self._dbus_iface is None:
  89.             try:
  90.                 self._dbus_iface = Backend.create_dbus_client()
  91.             except Exception, e:
  92.                 if hasattr(e, '_dbus_error_name') and e._dbus_error_name == \
  93.                     'org.freedesktop.DBus.Error.FileNotFound':
  94.                     if self.have_ui:
  95.                         self.error_message(self._('Cannot connect to D-BUS'),
  96.                             str(e))
  97.                     else:
  98.                         self.error_msg(str(e))
  99.                     sys.exit(1)
  100.                 else:
  101.                     raise
  102.             self._call_progress_dialog(
  103.                 self._('Searching for available drivers...'),
  104.                 self._dbus_iface.detect, timeout=600)
  105.         else:
  106.             # handle backend timeouts
  107.             try:
  108.                 self._dbus_iface.handler_info(' ')
  109.             except Exception, e:
  110.                 if hasattr(e, '_dbus_error_name') and e._dbus_error_name == \
  111.                     'org.freedesktop.DBus.Error.ServiceUnknown':
  112.                     self._dbus_iface = Backend.create_dbus_client()
  113.                     self._call_progress_dialog(
  114.                         self._('Searching for available drivers...'),
  115.                         self._dbus_iface.detect, timeout=600)
  116.  
  117.         return self._dbus_iface
  118.  
  119.     def _(self, str, convert_keybindings=False):
  120.         '''Keyboard accelerator aware gettext() wrapper.
  121.         
  122.         This optionally converts keyboard accelerators to the appropriate
  123.         format for the frontend.
  124.  
  125.         All strings in the source code should use the '_' prefix for key
  126.         accelerators (like in GTK). For inserting a real '_', use '__'.
  127.         '''
  128.         result = _(str)
  129.  
  130.         if convert_keybindings:
  131.             result = self.convert_keybindings(result)
  132.  
  133.         return result
  134.  
  135.     def init_strings(self):
  136.         '''Initialize all static strings which are used in UI implementations.'''
  137.  
  138.         self.string_handler = self._('Component')
  139.         self.string_button_enable = self._('_Enable', True)
  140.         self.string_button_disable = self._('_Disable', True)
  141.         self.string_enabled = self._('Enabled')
  142.         self.string_disabled = self._('Disabled')
  143.         self.string_status = self._('Status')
  144.         self.string_restart = self._('Needs computer restart')
  145.         self.string_in_use = self._('In use')
  146.         self.string_not_in_use = self._('Not in use')
  147.         self.string_license_label = self._('License:')
  148.         self.string_details = self._('details')
  149.         # this is used in the GUI and in --list output to denote free/restricted drivers
  150.         self.string_free = self._('Free')
  151.         # this is used in the GUI and in --list output to denote free/restricted drivers
  152.         self.string_restricted = self._('Proprietary')
  153.         self.string_download_progress_title = self._('Download in progress')
  154.         self.string_unknown_driver = self._('Unknown driver')
  155.         self.string_unprivileged = self._('You are not authorized to perform this action.')
  156.         # %s is the name of the operating system
  157.         self.string_support_certified = self._('Tested by the %s developers') % OSLib.inst.os_vendor
  158.         # %s is the name of the operating system
  159.         self.string_support_uncertified = self._('Not tested by the %s developers') % OSLib.inst.os_vendor
  160.         # this is used when one version of a driver is recommended over others
  161.         self.string_recommended = self._('Recommended')
  162.         self.string_license_dialog_title = self._('License Text for Device Driver')
  163.  
  164.     def main_window_title(self):
  165.         '''Return an appropriate translated window title.
  166.  
  167.         This might depend on the mode the program is called (e. g. showing only
  168.         free drivers, only restricted ones, etc.).
  169.         '''
  170.         if self.argv_options.mode == 'nonfree':
  171.             return self._('Restricted Hardware Drivers')
  172.         else:
  173.             return self._('Hardware Drivers')
  174.  
  175.     def main_window_text(self):
  176.         '''Return a tuple (heading, subtext) of main window texts.
  177.  
  178.         This changes depending on whether restricted or free drivers are
  179.         used/available, or if a search is currently running. Thus the UI should
  180.         update it whenever it changes a handler.
  181.         '''
  182.         if self.current_search[0]:
  183.             return (self._('Driver search results'),
  184.                 self.hwid_to_display_string(self.current_search[0]))
  185.  
  186.         proprietary_in_use = False
  187.         proprietary_available = False
  188.  
  189.         for h_id in self.backend().available(self.argv_options.mode):
  190.             info = self.backend().handler_info(h_id)
  191.             #print 'main_window_text: info for', h_id, info
  192.             if not bool(info['free']):
  193.                 proprietary_available = True
  194.                 if bool(info['used']):
  195.                     proprietary_in_use = True
  196.                     break
  197.  
  198.         if proprietary_in_use:
  199.             heading = self._('Proprietary drivers are being used to make '
  200.                     'this computer work properly.')
  201.         else:
  202.             heading = self._('No proprietary drivers are in use on this system.')
  203.  
  204.         if proprietary_available:
  205.             subtext = self._(
  206.             # %(os)s stands for the OS name. Prefix it or suffix it,
  207.             # but do not replace it.
  208.             'Proprietary drivers do not have public source code that %(os)s '
  209.             'developers are free to modify. Security updates and corrections '
  210.             'depend solely on the responsiveness of the manufacturer. '
  211.             '%(os)s cannot fix or improve these drivers.') % {'os': OSLib.inst.os_vendor}
  212.         else:
  213.             subtext = ''
  214.  
  215.         return (heading, subtext)
  216.  
  217.     def get_handler_category(self, handler_id):
  218.         '''Return string for handler category.'''
  219.  
  220.         if handler_id.startswith('xorg:'):
  221.             return self._('Graphics driver')
  222.         elif handler_id.startswith('firmware:'):
  223.             return self._('Firmware')
  224.         else:
  225.             return self._('Device driver')
  226.  
  227.     def get_ui_driver_name(self, handler_info):
  228.         '''Return handler name, as it should be presented in the UI.
  229.         
  230.         This cares about translation, as well as tagging recommended drivers.
  231.         '''
  232.         result = handler_info['name']
  233.         result = self._(result)
  234.         if 'version' in handler_info:
  235.             result += ' (%s)' % (self._('version %s') % handler_info['version'])
  236.         if bool(handler_info['recommended']):
  237.             result += ' [%s]' % self.string_recommended
  238.         return result
  239.  
  240.     # TODO: this desperately needs test cases
  241.     def get_ui_driver_info(self, handler_id):
  242.         '''Get strings and icon types for displaying driver information.
  243.         
  244.         If handler_id is None, this returns empty strings, suitable for
  245.         displaying if no driver is selected, and "None" for the bool values,
  246.         (UIs should disable the corresponding UI element then).
  247.         
  248.         This returns a mapping with the following keys: name (string),
  249.         description (string), certified (bool, for icon), certification_label
  250.         (label string), free (bool, for icon), license_label
  251.         (Free/Proprietary, label string), license_text (string, might be
  252.         empty), enabled (bool, for icon), used (bool), needs_reboot(bool),
  253.         status_label (label string), button_toggle_label (string)'''
  254.  
  255.         if not handler_id:
  256.             return { 'name': '', 'description': '', 'free': None, 
  257.                 'enabled': None, 'used': None, 'license_text': '',
  258.                 'status_label': '', 'license_label': '', 'certified': None,
  259.                 'certification_label': '', 'button_toggle_label': None,
  260.             }
  261.  
  262.         info = self.backend().handler_info(handler_id)
  263.  
  264.         result = {
  265.             'name': self.get_ui_driver_name(info),
  266.             'description': self._get_description_rationale_text(info),
  267.             'free': bool(info['free']),
  268.             'enabled': bool(info['enabled']),
  269.             'used': bool(info['used']),
  270.             'needs_reboot': False,
  271.             'license_text': info.get('license', '')
  272.         }
  273.  
  274.         if result['free']:
  275.             result['license_label'] = self.string_free
  276.         else:
  277.             result['license_label'] = self.string_restricted
  278.  
  279.         # TODO: support distro certification of third party drivers
  280.         if 'repository' not in info:
  281.             result['certified'] = True 
  282.             result['certification_label'] = self.string_support_certified
  283.         else:
  284.             result['certified'] = False 
  285.             result['certification_label'] = self.string_support_uncertified
  286.  
  287.         if result['enabled']:
  288.             if 'package' in info:
  289.                 result['button_toggle_label'] = self._('_Remove', True)
  290.             else:
  291.                 result['button_toggle_label'] = self._('_Deactivate', True)
  292.             if result['used']:
  293.                 result['status_label'] = self._('This driver is activated and currently in use.')
  294.             else:
  295.                 if bool(info['changed']):
  296.                     result['needs_reboot'] = True
  297.                     result['status_label'] = self._('You need to restart the computer to activate this driver.')
  298.                 else:
  299.                     result['status_label'] = self._('This driver is activated but not currently in use.')
  300.         else:
  301.             result['button_toggle_label'] = self._('_Activate', True)
  302.             if result['used']:
  303.                 if bool(info['changed']):
  304.                     result['needs_reboot'] = True
  305.                     result['status_label'] = self._('This driver was just disabled, but is still in use.')
  306.                 else:
  307.                     result['status_label'] = self._('A different version of this driver is in use.')
  308.             else:
  309.                 result['status_label'] = self._('This driver is not activated.')
  310.  
  311.         return result
  312.  
  313.     def parse_argv(self):
  314.         '''Parse command line arguments, and return (options, args) pair.'''
  315.  
  316.         # --check can have an optional numeric argument which sleeps for the
  317.         # given number of seconds; this is mostly useful for the XDG autostart
  318.         # .desktop file, to not do expensive operations right at session start
  319.         def check_option_callback(option, opt_str, value, parser):
  320.             if len(parser.rargs) > 0 and parser.rargs[0].isdigit():
  321.                 setattr(parser.values, 'check', int(parser.rargs.pop(0)))
  322.             else:
  323.                 setattr(parser.values, 'check', 0)
  324.  
  325.         parser = optparse.OptionParser()
  326.         parser.set_defaults(check=None)
  327.         parser.add_option ('-c', '--check', action='callback',
  328.                 callback=check_option_callback,
  329.                 help=self._('Check for newly used or usable drivers and notify the user.'))
  330.         parser.add_option ('-u', '--update-db', action='store_true',
  331.                 dest='update_db', default=False,
  332.                 help=self._('Query driver databases for newly available or updated drivers.'))
  333.         parser.add_option ('-l', '--list', action='store_true',
  334.                 dest='list', default=False,
  335.                 help=self._('List available drivers and their status.'))
  336.         parser.add_option ('--hardware-ids', action='store_true',
  337.                 dest='list_hwids', default=False,
  338.                 help=self._('List hardware identifiers from this system.'))
  339.         parser.add_option ('-e', '--enable', type='string',
  340.                 dest='enable', default=None, metavar='DRIVER',
  341.                 help=self._('Enable a driver'))
  342.         parser.add_option ('-d', '--disable', type='string',
  343.                 dest='disable', default=None, metavar='DRIVER',
  344.                 help=self._('Disable a driver'))
  345.         parser.add_option ('--confirm', action='store_true',
  346.                 dest='confirm', default=False,
  347.                 help=self._('Ask for confirmation for --enable/--disable'))
  348.         parser.add_option ('-C', '--check-composite', action='store_true',
  349.                 dest='check_composite', default=False,
  350.                 help=self._('Check if there is a graphics driver available that supports composite and offer to enable it'))
  351.         parser.add_option ('-m', '--mode',
  352.                 type='choice', dest='mode', default='any',
  353.                 choices=['free', 'nonfree', 'any'],
  354.                 metavar='free|nonfree|any',
  355.                 help=self._('Only manage free/nonfree drivers. By default, all'
  356.                 ' available drivers with any license are presented.'))
  357.         parser.add_option ('--dbus-server', action='store_true',
  358.                 dest='dbus_server', default=False,
  359.                 help=self._('Run as session D-BUS server.'))
  360.         #parser.add_option ('--debug', action='store_true',
  361.         #        dest='debug', default=False,
  362.         #        help=self._('Enable debugging messages.'))
  363.  
  364.         (opts, args) = parser.parse_args()
  365.  
  366.         return (opts, args)
  367.  
  368.     def run(self):
  369.         '''Evaluate command line arguments and do the appropriate action.
  370.  
  371.         If no argument was specified, this starts the interactive UI.
  372.         
  373.         This returns the exit code of the program.
  374.         '''
  375.         # first, modes without GUI
  376.         if self.argv_options.update_db:
  377.             self.backend().update_driverdb()
  378.             return 0
  379.         elif self.argv_options.list:
  380.             self.list()
  381.             return 0
  382.         elif self.argv_options.list_hwids:
  383.             self.list_hwids()
  384.             return 0
  385.         elif self.argv_options.dbus_server:
  386.             self.dbus_server()
  387.             return 0
  388.         elif self.argv_options.check is not None:
  389.             if self.check():
  390.                 return 0
  391.             else:
  392.                 return 1
  393.  
  394.         # all other modes involve the GUI, so load it
  395.         self.ui_init()
  396.         self.have_ui = True
  397.  
  398.         if self.argv_options.enable:
  399.             if self.set_handler_enable(self.argv_options.enable, 'enable',
  400.                 self.argv_options.confirm, False):
  401.                 return 0
  402.             else:
  403.                 return 1
  404.         elif self.argv_options.disable:
  405.             if self.set_handler_enable(self.argv_options.disable, 'disable',
  406.                 self.argv_options.confirm, False):
  407.                 return 0
  408.             else:
  409.                 return 1
  410.         elif self.argv_options.check_composite:
  411.             if self.check_composite():
  412.                 return 0
  413.             else:
  414.                 return 1
  415.  
  416.         # start the UI
  417.         self.ui_show_main()
  418.         return self.ui_main_loop()
  419.  
  420.     def list(self):
  421.         '''Print a list of available handlers and their status to stdout.'''
  422.  
  423.         for h_id in self.backend().available(self.argv_options.mode):
  424.             i = self.backend().handler_info(h_id)
  425.             print '%s - %s (%s, %s, %s)' % (
  426.                 h_id, i['name'],
  427.                 bool(i['free']) and self.string_free or self.string_restricted,
  428.                 bool(i['enabled']) and self.string_enabled or self.string_disabled,
  429.                 bool(i['used']) and self.string_in_use or self.string_not_in_use)
  430.  
  431.     def list_hwids(self):
  432.         '''Print a list of available handlers and their status to stdout.'''
  433.  
  434.         for h_id in self.backend().get_hardware():
  435.             print h_id
  436.  
  437.     def check(self):
  438.         '''Notify the user about newly used or available drivers since last check().
  439.         
  440.         Return True if any new driver is available which is not yet enabled.
  441.         '''
  442.         try:
  443.             (new_used, new_avail) = convert_dbus_exceptions(
  444.                     self.backend().new_used_available, self.argv_options.mode)
  445.         except PermissionDeniedByPolicy:
  446.             self.error_msg(self.string_unprivileged)
  447.             return False
  448.  
  449.         # any new restricted drivers? also throw out the non-announced ones
  450.         restricted_available = False
  451.         for h_id in set(new_avail): # create copy
  452.             info = self.backend().handler_info(h_id)
  453.             if not bool(info['announce']):
  454.                 new_avail.remove(h_id)
  455.                 continue
  456.             if not bool(info['free']):
  457.                 restricted_available = True
  458.                 break
  459.  
  460.         # throw out newly used free drivers; no need for education here
  461.         for h_id in new_used + []: # create copy for iteration
  462.             if bool(self.backend().handler_info(h_id)['free']):
  463.                 new_used.remove(h_id)
  464.  
  465.         notified = False
  466.  
  467.         # launch notifications if anything remains
  468.         if new_avail or new_used:
  469.             # defer UI initialization until here, since --check should not
  470.             # spawn a progress dialog for searching drivers
  471.             self.ui_init()
  472.             self.have_ui = True
  473.  
  474.         if new_avail:
  475.             if restricted_available:
  476.                 self.ui_notification(self._('Restricted drivers available'),
  477.                     self._('In order to use your hardware more efficiently, you'
  478.                     ' can enable drivers which are not free software.'))
  479.             else:
  480.                 self.ui_notification(self._('New drivers available'),
  481.                     self._('There are new or updated drivers available for '
  482.                     'your hardware.'))
  483.             notified = True
  484.         elif new_used:
  485.             self.ui_notification(self._('New restricted drivers in use'),
  486.                 # %(os)s stands for the OS name. Prefix it or suffix it,
  487.                 # but do not replace it.
  488.                 self._('In order for this computer to function properly, %(os)s is '
  489.                 'using driver software that cannot be supported by %(os)s.') % 
  490.                     {'os': OSLib.inst.os_vendor})
  491.             notified = True
  492.  
  493.         if notified:
  494.             # we need to stay in the main loop so that the tray icon stays
  495.             # around
  496.             self.ui_main_loop()
  497.  
  498.         return len(new_avail) > 0
  499.  
  500.     def check_composite(self):
  501.         '''Check for a composite-enabling X.org driver.
  502.  
  503.         If one is available and not installed, offer to install it and return
  504.         True if installation succeeded. Otherwise return False.
  505.         '''
  506.  
  507.         h_id = self.backend().check_composite()
  508.  
  509.         if h_id:
  510.             self.set_handler_enable(h_id, 'enable', True)
  511.             return bool(self.backend().handler_info(h_id)['enabled'])
  512.  
  513.         self.error_msg(self._('There is no available graphics driver for your system which supports the composite extension, or the current one already supports it.'))
  514.         return False
  515.  
  516.     def _install_progress_handler(self, phase, cur, total):
  517.         if not self._install_progress_shown:
  518.             self.ui_progress_start('', 
  519.                 self._('Downloading and installing driver...'), total)
  520.             self._install_progress_shown = True
  521.         self.ui_progress_update(cur, total)
  522.         self.ui_idle()
  523.  
  524.     def _remove_progress_handler(self, cur, total):
  525.         if not self._install_progress_shown:
  526.             self.ui_progress_start('', 
  527.                 self._('Removing driver...'), total)
  528.             self._install_progress_shown = True
  529.         self.ui_progress_update(cur, total)
  530.         self.ui_idle()
  531.  
  532.     def set_handler_enable(self, handler_id, action, confirm, gui=True):
  533.         '''Enable, disable, or toggle a handler.
  534.  
  535.         action can be 'enable', 'disable', or 'toggle'. If confirm is True,
  536.         this first presents a confirmation dialog. Then a progress dialog is
  537.         presented for installation/removal of the handler.
  538.  
  539.         If gui is True, error messags and install progress will be shown
  540.         in the GUI, otherwise just printed to stderr (CLI mode).
  541.  
  542.         Return True if anything was changed and thus the UI needs to be
  543.         refreshed.
  544.         '''
  545.         try:
  546.             i = convert_dbus_exceptions(self.backend().handler_info, handler_id)
  547.         except UnknownHandlerException:
  548.             self.error_msg('%s: %s' % (self.string_unknown_driver, handler_id))
  549.             self.error_msg(self._('Use --list to see available drivers'))
  550.             return False
  551.  
  552.         # determine new status
  553.         if action == 'enable':
  554.             enable = True
  555.         elif action == 'disable':
  556.             enable = False
  557.         elif action == 'toggle':
  558.             enable = not bool(i['enabled'])
  559.         else:
  560.             raise ValueError, 'invalid action %s; allowed are enable, disable, toggle'
  561.  
  562.         # check if we can change at all
  563.         if 'can_change' in i:
  564.             msg = i['can_change']
  565.             if gui:
  566.                 self.error_message(self._('Cannot change driver'),
  567.                     self._(msg))
  568.             else:
  569.                 self.error_msg(self._(msg))
  570.             return False
  571.  
  572.         # actually something to change?
  573.         if enable == bool(i['enabled']):
  574.             return False
  575.  
  576.         if confirm:
  577.             # construct and ask confirmation question
  578.             if enable:
  579.                 title = self._('Enable driver?')
  580.                 action = self.string_button_enable
  581.             else:
  582.                 title = self._('Disable driver?')
  583.                 action = self.string_button_disable
  584.             n = i['name'] # self._(i['name']) is misinterpreted by xgettext
  585.             if not self.confirm_action(title, self._(n), 
  586.                 self._get_description_rationale_text(i), action):
  587.                 return False
  588.  
  589.         # go
  590.         try:
  591.             if gui:
  592.                 try:
  593.                     self._install_progress_shown = False
  594.                     convert_dbus_exceptions(dbus_sync_call_signal_wrapper, self.backend(),
  595.                         'set_enabled',
  596.                         {'install_progress': self._install_progress_handler, 
  597.                          'remove_progress': self._remove_progress_handler}, 
  598.                         handler_id, enable)
  599.                 finally:
  600.                     if self._install_progress_shown:
  601.                         self.ui_progress_finish()
  602.             else:
  603.                 convert_dbus_exceptions(dbus_sync_call_signal_wrapper,
  604.                         self.backend(), 'set_enabled', {}, handler_id, enable)
  605.         except PermissionDeniedByPolicy:
  606.             self.error_message('', self.string_unprivileged)
  607.             return False
  608.         except BackendCrashError:
  609.             self._dbus_iface = None
  610.             self.error_message('', '%s\n\n  ubuntu-bug jockey-common\n\n%s' % (
  611.                 self._('Sorry, the Jockey backend crashed. Please file a bug at:'),
  612.                 self._('Trying to recover by restarting backend.')))
  613.             return False
  614.         except SystemError, e:
  615.             self.error_message('', str(e).strip().splitlines()[-1])
  616.             return False
  617.  
  618.         newstate = bool(self.backend().handler_info(handler_id)['enabled'])
  619.         return i['enabled'] != newstate
  620.  
  621.     def _get_description_rationale_text(self, h_info):
  622.         d = h_info.get('description', '')
  623.         r = h_info.get('rationale', '')
  624.         # opportunistic translation (shipped example drivers have translations)
  625.         if d:
  626.             d = self._(d)
  627.         if r:
  628.             r = self._(r)
  629.  
  630.         if d and r:
  631.             return d.strip() + '\n\n' + r
  632.         elif d:
  633.             return d
  634.         elif r:
  635.             return r
  636.         else:
  637.             return ''
  638.  
  639.     def download_url(self, url, filename=None, data=None):
  640.         '''Download an URL into a local file, and display a progress dialog.
  641.         
  642.         If filename is not given, a temporary file will be created.
  643.  
  644.         Additional POST data can be submitted for HTTP requests in the data
  645.         argument (see urllib2.urlopen).
  646.  
  647.         Return (filename, headers) tuple, or (None, headers) if the user
  648.         cancelled the download.
  649.         '''
  650.         block_size = 8192
  651.         current_size = 0
  652.         try:
  653.             f = urllib2.urlopen(url)
  654.         except Exception, e:
  655.             self.error_message(self._('Download error'), str(e))
  656.             return (None, None)
  657.         headers = f.info()
  658.  
  659.         if 'Content-Length' in headers:
  660.             total_size = int(headers['Content-Length'])
  661.         else:
  662.             total_size = -1
  663.  
  664.         self.ui_progress_start(self.string_download_progress_title, url,
  665.             total_size)
  666.  
  667.         if filename:
  668.             tfp = open(filename, 'wb')
  669.             result_filename = filename
  670.         else:
  671.             (fd, result_filename) = tempfile.mkstemp()
  672.             tfp = os.fdopen(fd, 'wb')
  673.  
  674.         try:
  675.             while current_size < total_size:
  676.                 block = f.read(block_size)
  677.                 tfp.write (block)
  678.                 current_size += len(block)
  679.                 # if True, user canceled download
  680.                 if self.ui_progress_update(current_size, total_size):
  681.                     # if we created a temporary file, clean it up
  682.                     if not filename:
  683.                         os.unlink(result_filename)
  684.                     result_filename = None
  685.                     break
  686.         finally:
  687.             tfp.close()
  688.             f.close()
  689.             self.ui_progress_finish()
  690.  
  691.         return (result_filename, headers)
  692.  
  693.     @classmethod
  694.     def error_msg(klass, msg):
  695.         '''Print msg to stderr, and intercept IOErrors.'''
  696.  
  697.         try:
  698.             print >> sys.stderr, msg
  699.         except IOError:
  700.             pass
  701.  
  702.     def _call_progress_dialog(self, message, fn, *args, **kwargs):
  703.         '''Call fn(*args, **kwargs) while showing a progress dialog.'''
  704.  
  705.         if not self.have_ui:
  706.             return fn(*args, **kwargs)
  707.  
  708.         progress_shown = False
  709.         t_fn = threading.Thread(None, fn, 'thread_call_progress_dialog',
  710.             args, kwargs)
  711.         t_fn.start()
  712.         while True:
  713.             t_fn.join(0.2)
  714.             if not t_fn.isAlive():
  715.                 break
  716.             if not progress_shown:
  717.                 progress_shown = True
  718.                 self.ui_progress_start('', message, -1)
  719.             if self.ui_progress_update(-1, -1):
  720.                 sys.exit(1) # cancel
  721.             self.ui_idle()
  722.         if progress_shown:
  723.             self.ui_progress_finish()
  724.             self.ui_idle()
  725.  
  726.     def get_displayed_handlers(self):
  727.         '''Return the list of displayed handler IDs.
  728.  
  729.         This can either be a list of drivers which match your system, or which
  730.         match a search_driver() invocation.
  731.         '''
  732.         if self.current_search[0]:
  733.             return self.current_search[1]
  734.         else:
  735.             return self.backend().available(self.argv_options.mode)
  736.  
  737.     def hwid_to_display_string(self, hwid):
  738.         '''Convert a type:value hardware ID string to a human friendly text.'''
  739.  
  740.         try:
  741.             (type, value) = hwid.split(':', 1)
  742.         except ValueError:
  743.             return hwid
  744.  
  745.         if type == 'printer_deviceid':
  746.             try:
  747.                 import cupshelpers
  748.             except ImportError:
  749.                 return hwid
  750.             info = cupshelpers.parseDeviceID(value)
  751.             return info['MFG'] + ' ' + info['MDL']
  752.  
  753.         return hwid
  754.  
  755.     #
  756.     # Session D-BUS server methods
  757.     # 
  758.  
  759.     DBUS_INTERFACE_NAME = 'com.ubuntu.DeviceDriver'
  760.  
  761.     def dbus_server(self):
  762.         '''Run session D-BUS server backend.'''
  763.  
  764.         dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
  765.         bus = dbus.SessionBus()
  766.         dbus_name = dbus.service.BusName(DBUS_BUS_NAME, bus)
  767.  
  768.         dbus.service.Object.__init__(self, bus, '/GUI')
  769.         self.dbus_server_main_loop = gobject.MainLoop()
  770.         self.dbus_server_main_loop.run()
  771.  
  772.     @classmethod
  773.     def get_dbus_client(klass):
  774.         '''Return a dbus.Interface object for the server.'''
  775.  
  776.         obj = dbus.SessionBus().get_object(DBUS_BUS_NAME, '/GUI')
  777.         return dbus.Interface(obj, AbstractUI.DBUS_INTERFACE_NAME)
  778.  
  779.     @dbus.service.method(DBUS_INTERFACE_NAME,
  780.         in_signature='s', out_signature='bas', sender_keyword='sender',
  781.         connection_keyword='conn')
  782.     def search_driver(self, hwid, sender=None, conn=None):
  783.         '''Search configured driver DBs for a particular hardware component.
  784.  
  785.         The hardware component is described as HardwareID type and value,
  786.         separated by a colon. E. g.  "modalias:pci:12345" or
  787.         "printer_deviceid:MFG:FooTech;MDL:X-12;CMD:GDI". This searches the
  788.         enabled driver databases for a matching driver. If it finds one, it
  789.         offers it to the user. This returns a pair (success, files); where
  790.         'success' is True if a driver was found, acknowledged by the user, and
  791.         installed, otherwise False; "files" is the list of files shipped by the
  792.         newly installed packages (useful for e. g. printer drivers to get a
  793.         list of PPDs to check).
  794.         '''
  795.         self.ui_init() # we want to show progress
  796.         self.have_ui = True
  797.  
  798.         b = self.backend()
  799.  
  800.         def _srch():
  801.             # TODO: this is a hack: when calling through D-BUS, specify a
  802.             # timeout, when calling a local object, the timeout parameter does
  803.             # not exist
  804.             if hasattr(b, '_locations'):
  805.                 drivers = self._dbus_iface.search_driver(hwid, timeout=600)
  806.             else:
  807.                 drivers = b.search_driver(hwid)
  808.             self.current_search = (hwid, drivers)
  809.  
  810.         self._call_progress_dialog(self._(
  811.             'Searching driver for %s...') % self.hwid_to_display_string(hwid),
  812.             _srch)
  813.  
  814.         result = False
  815.         files = []
  816.  
  817.         if self.current_search[1]:
  818.             self.ui_show_main()
  819.             self.ui_main_loop()
  820.             for d in self.current_search[1]:
  821.                 info = self.backend().handler_info(d)
  822.                 if bool(info['enabled']) and bool(info['changed']):
  823.                     result = True
  824.                     if 'package' in info:
  825.                         files += self.backend().handler_files(d)
  826.  
  827.         # we are D-BUS activated, so let's free resources early
  828.         if self.dbus_server_main_loop:
  829.             self.dbus_server_main_loop.quit()
  830.  
  831.         return (result, files)
  832.  
  833.     #
  834.     # The following methods must be implemented in subclasses
  835.     # 
  836.  
  837.     def convert_keybindings(self, str):
  838.         '''Convert keyboard accelerators to the particular UI's format.
  839.  
  840.         The abstract UI and drivers use the '_' prefix to mark a keyboard
  841.         accelerator.
  842.  
  843.         A double underscore ('__') is converted to a real '_'.'''
  844.  
  845.         raise NotImplementedError, 'subclasses need to implement this'
  846.  
  847.     def ui_init(self):
  848.         '''Initialize UI.
  849.  
  850.         This should load the GUI components, such as GtkBuilder files, but not
  851.         show the main window yet; that is done by ui_show_main().
  852.         '''
  853.         raise NotImplementedError, 'subclasses need to implement this'
  854.         
  855.     def ui_show_main(self):
  856.         '''Show main window.
  857.  
  858.         This should set up presentation of handlers and show the main
  859.         window. This must be called after ui_init().
  860.         '''
  861.         raise NotImplementedError, 'subclasses need to implement this'
  862.  
  863.     def ui_main_loop(self):
  864.         '''Main loop for the user interface.
  865.         
  866.         This should return if the user wants to quit the program, and return
  867.         the exit code.
  868.         '''
  869.         raise NotImplementedError, 'subclasses need to implement this'
  870.  
  871.     def error_message(self, title, text):
  872.         '''Present an error message box.'''
  873.  
  874.         raise NotImplementedError, 'subclasses need to implement this'
  875.  
  876.     def confirm_action(self, title, text, subtext=None, action=None):
  877.         '''Present a confirmation dialog.
  878.  
  879.         If action is given, it is used as button label instead of the default
  880.         'OK'.  Return True if the user confirms, False otherwise.
  881.         '''
  882.         raise NotImplementedError, 'subclasses need to implement this'
  883.  
  884.     def ui_notification(self, title, text):
  885.         '''Present a notification popup.
  886.  
  887.         This should preferably create a tray icon. Clicking on the tray icon or
  888.         notification should run the GUI.
  889.         '''
  890.         raise NotImplementedError, 'subclasses need to implement this'
  891.  
  892.     def ui_idle(self):
  893.         '''Process pending UI events and return.
  894.  
  895.         This is called while waiting for external processes such as package
  896.         installers.
  897.         '''
  898.         raise NotImplementedError, 'subclasses need to implement this'
  899.  
  900.     def ui_progress_start(self, title, description, total):
  901.         '''Create a progress dialog.'''
  902.  
  903.         raise NotImplementedError, 'subclasses need to implement this'
  904.  
  905.     def ui_progress_update(self, current, total):
  906.         '''Update status of current progress dialog.
  907.         
  908.         current/total specify the number of steps done and total steps to
  909.         do, or -1 if it cannot be determined. In this case the dialog should
  910.         display an indeterminated progress bar (bouncing back and forth).
  911.  
  912.         This should return True to cancel, and False otherwise.
  913.         '''
  914.         raise NotImplementedError, 'subclasses need to implement this'
  915.  
  916.     def ui_progress_finish(self):
  917.         '''Close the current progress dialog.'''
  918.  
  919.         raise NotImplementedError, 'subclasses need to implement this'
  920.